home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / aed243a.zip / AEDMRG.DOC < prev    next >
Text File  |  1990-06-10  |  13KB  |  326 lines
  1. 03-22-90 AEDMRG.DOC
  2.  
  3. This is the ANSIED merge for RBBS v17.3x.  ANSIED is a full-screen editor
  4. for entering messages.  The current version is v2.43.  It is compilable
  5. with QuickBASIC v4.5 or v3.0.
  6.  
  7.  
  8. What's in this ZIP:
  9.  
  10.     AEDMRG.DOC    - What you're reading now.
  11.  
  12.     AED243.BAS    - Standalone version of ANSIED.BAS.  Can be loaded into
  13.                     the QuickBASIC v4.5 environment and run. I use this
  14.                     version to figure out bugs.
  15.  
  16.     ANSIED.HLP    - Editor help file.  Put this in the directory that all
  17.                     of your other RBBS help files are, and ANSIED will
  18.                     display this for it's internal help command.
  19.  
  20.     ANSIED.BAS    - The full-screen editor program source.
  21.  
  22.     ANSIED-3.BAS  - The full-screen editor program source,  compilable with
  23.                     QuickBASIC v3.0.
  24.  
  25.     *.MRG         - Merges to RBBS-PC.BAS for the editor.  For detailed
  26.                     information, see below.
  27.  
  28.     UPGRADE4.BAT  - RBBS recompile batch file.  Uses QB v4.5.
  29.  
  30.     LINK4.DAT     - Linker data file when NOT including ANSIED in your
  31.                     merges.
  32.  
  33.     LINK4A.DAT    - Linker data file when including ANSIED.
  34.  
  35.     UPGRADE3.BAT  - RBBS recompile/link files for QuickBASIC v3.0.
  36.     LINK3.DAT
  37.     LINK3A.DAT
  38.  
  39.  
  40. What's New since v2.42:
  41.  
  42.     ANSIED has gotten an awful lot of attention in the RBBS community of
  43.     late.  Most of the changes/improvements are due to suggestions by
  44.     users, predominately Mike Zakharoff and Nathan Barber, who each run
  45.     outstanding bulletin board systems.
  46.  
  47.     o  Status Line.  Shows message To: and From: fields, as well as Ins/Ovw
  48.        status.
  49.  
  50.     o  Cursor keys, INS, and DEL keys now work locally.  When a remote user
  51.        is online, the cursor keys work to adjust security/time levels.
  52.  
  53.     o  Local sysop can type at the same time as the user, to "guide" the
  54.        user in the use of the editor.
  55.  
  56.     o  Delete key didn't work correctly.  Fixed.
  57.  
  58.     o  When quoting a message, the cursor starts below the quoted lines,
  59.        rather than always on line 1.  Message is scrolled to ensure that
  60.        the user will begin typing approximately halfway down the screen.
  61.  
  62.     o  ANSI escape sequences are removed from quotes before editing.
  63.        Previously, a quoted message containing ANSI would distort the
  64.        display.
  65.  
  66.     o  Right Margin: The user's actual right margin setting is now used
  67.        when wrapping long lines and right justifying.  Version 2.42 always
  68.        used a value of 75.
  69.  
  70.     o  RBBS' maximum message length is now honored, and text can't be added
  71.        below the value set in CONFIG.
  72.  
  73.     o  Lines that are "locked" by RBBS can't be modified or deleted.
  74.  
  75.     o  "Loading DOOR. Please Wait..." message comes up twice in "UGLY"
  76.        merges.  Fixed.
  77.  
  78.     o  If you use the "UGLY" or "EDIT" merges, the editor is available to
  79.        COLOR users or users with highlighting on.  When using the "UTOG" or
  80.        "ETOG" merges, any user can elect to use the editor, independent of
  81.        graphics mode or highlighting.
  82.  
  83.     o  The parts of the "UGLY" merges that removed RBBS support for
  84.        background colors were removed.
  85.  
  86.     o  The "UGLY" and "UTOG" merges allow macros to be constrained when
  87.        using PUIs.  To restrict a command to a given PUI, use the macros
  88.        constraint of "/x /", where 'x' is the first letter of the name of
  89.        the PUI.  To constrain a command to TOP.PUI, for example, use "/T /"
  90.        as the macro constraint.
  91.  
  92.     o  RBBS-PC v17.2x merges removed from the main ZIP.
  93.  
  94.     o  ANSIED.BAS partially recoded to eliminate redundant or unnecessary
  95.        code.  Even with the new enhancements, ANSIED v2.43 is SMALLER (by
  96.        about 1K of EXE size) than v2.42.
  97.  
  98.  
  99. Merges:
  100.  
  101.     When modifications or fixes are made to the main RBBS program, rather
  102.     than releasing an entire new set of source code, changes are released
  103.     as "merges" - files that contain the DIFFERENCE between the original
  104.     RBBS version and the new RBBS version.  Ken Goosens' BLED program is
  105.     used to merge the new changes into the old version.  This new "merged"
  106.     RBBS-PC is then recompiled.  The ANSIED merges follow in this
  107.     tradition.
  108.  
  109.     Included in this archive are:
  110.  
  111.        R???EDIT.MRG
  112.        R???UGLY.MRG
  113.        R???ETOG.MRG
  114.        R???UTOG.MRG
  115.  
  116.     What's the difference?  Well, the "EDIT" and "ETOG" merges just include
  117.     the changes necessary to include ANSIED in the final RBBS-PC.EXE.  The
  118.     "UGLY" and "UTOG" merges include the editor, change a few of RBBS'
  119.     prompts, and fix a few minor bugs in the code that the authors don't
  120.     acknowledge as being bugs.  If you think RBBS' prompts are fine as is,
  121.     and don't have problems with macros or the PUI, use the "EDIT" or
  122.     "ETOG" merges.
  123.  
  124.     Now, what about the "EDIT" verses the "ETOG" merges?  Well, if you
  125.     install the "EDIT" merges, then whenever a user goes to enter a
  126.     message, he'll be prompted with "Use the ANSI Screen Editor (Y/[N])?"
  127.     If you install the "ETOG" merges, the choice of an editor is installed
  128.     in the RBBS code as a T)oggle.  With "ETOG" (and "UTOG"), the user can
  129.     turn the editor on or off from the utilities section.  No prompting
  130.     will ever occur.
  131.  
  132.     So, let's get it straight.  If the merges' name has a "U" in it ("Ugly"
  133.     or "Utog"), then the merge changes RBBS' prompts and fixes bugs.  If
  134.     there's no "U," the merge just includes the editor.  If the merges'
  135.     name contains the string "TOG," then the editor is installed as a
  136.     TOGgle to select it.  This gives us four possible merges, thus the four
  137.     sets included in this ZIP.
  138.  
  139.     Now, why would you NOT want to use the "TOG"-style merges?  Well, these
  140.     merges use a previously unused bit field in the RBBS users record to
  141.     record whether the fullscreen editor is turned on or not for a given
  142.     user.  In theory, future RBBS versions could use this bit for something
  143.     else.  So, be forewarned... if you use the "TOG" merges, they *may* not
  144.     work with future RBBS versions.
  145.  
  146.  
  147. How to Merge it:
  148.  
  149.    To merge ANSIED in your current RBBS version, do the following:
  150.  
  151.       a) Figure out which set of merges you want to use.
  152.  
  153.       b) Get the RBBS-VAR.BAS file from your current RBBS version.  It MUST
  154.          be the current version that you intend to compile.  If you merge
  155.          in RFIXes, the RFIXed RBBS-VAR.BAS is what you'd have to use.
  156.  
  157.       c) If you're using the "EDIT" or "UGLY" merges, skip this step.  If
  158.          you're using the "ETOG" or "UTOG" merges, then...
  159.  
  160.          i)  Edit RBBS-VAR.BAS, and add the following line:
  161.  
  162.              ZFullScreenEditor, _
  163.  
  164.              Note the comma and the underline after the variable name.
  165.  
  166.              It's recommended that you add this in alphabetical order with
  167.              the other variables in the file.  In RBBS-VAR.BAS for RBBS
  168.              version 17.3/0227, this is after the variable
  169.              ZFreeSpaceUpldFile$.
  170.  
  171.          ii) Save this file.
  172.  
  173.       d) Copy RBBS-VAR.BAS to a new name, called RBBS-VAR.MOD, like this:
  174.  
  175.          C:\RBBSWORK>copy RBBS-VAR.BAS RBBS-VAR.MOD
  176.  
  177.          This creates a file called RBBS-VAR.MOD, which is identical to
  178.          RBBS-VAR.BAS.
  179.  
  180.          If you did step b), this RBBS-VAR.BAS is the NEW one.
  181.  
  182.       e) Edit RBBS-VAR.MOD, and comment out the last line in the file by
  183.          putting a single quote at the beginning of the line.  It should
  184.          look like this:
  185.  
  186.          +--- Column 1
  187.          v
  188.          ' DEF FNOffOn$ (Switch) = MID$("OffOn", 1 - 3 * (Switch <> 0), 3)
  189.  
  190.          Save this file.
  191.  
  192.       f) Put all of the R*.BAS files in a work directory, along with the
  193.          .OBJ version of all of the assembler routines.  The R*.BAS files
  194.          usually come from a file called RBBS-BAS.ZIP.  The .OBJs are
  195.          usually in RBBS-ASM.ZIP.  Also make sure that ANSIED.BAS and
  196.          RBBS-VAR.MOD are in this directory.
  197.  
  198.       g) Edit UPGRADE4.BAT and LINK4x.DAT to reflect your paths.  UPGRADE4
  199.          and LINK4x assume the following paths:
  200.  
  201.          BC.EXE        (QuickBASIC v4.5 compiler) - C:\QB45
  202.          BLED.EXE      (Goosen's merge program)   - C:\QB45
  203.          BCOM45.LIB    (QuickBASIC library)       - C:\QB45\LIB
  204.          LINK.EXE      (Microsoft linker)         - In the PATH
  205.          R*.BAS        (RBBS .BAS files)          - Current Directory
  206.          *.OBJ         (RBBS .OBJ files)          - Current Directory
  207.          ANSIED.BAS    (Screen editor source)     - Current Directory
  208.          RBBS-VAR.MOD  (Modified RBBS-VAR.BAS)    - Current Directory
  209.  
  210.       h) Run UPGRADE4 as follows:
  211.  
  212.              upgrade4 edit y /r
  213.  
  214.                  -or-
  215.  
  216.              upgrade4 ugly y /r
  217.  
  218.                  -or-
  219.  
  220.              upgrade4 etog y /r
  221.  
  222.                  -or-
  223.  
  224.              upgrade4 utog y /r
  225.  
  226.          Note:
  227.  
  228.          The generic form of the UPGRADE4 command line is:
  229.  
  230.              upgrade4 xxxx <y/n> </r>
  231.                       ^      ^    ^
  232.                       |      |    +-- Just do RBBS-PC, no CONFIG
  233.                       |      |
  234.                       |      +-- compile after merging?
  235.                       |
  236.                       +-- merges name ... R-PCxxxx.MRG or RSB2xxxx.MRG
  237.                                           will be merged. (4 chars)
  238.  
  239.          So, UPGRADE4 can be used for RBBS version/fix upgrades, as well as
  240.          for merging ANSIED.  Here's a command line for RBBS v17.2A -> v17.2B:
  241.  
  242.              upgrade4 172b y
  243.  
  244.          To just compile RBBS, without merging anything, specify a merge
  245.          name that doesn't exist.  Like this:
  246.  
  247.              upgrade4 junk y
  248.  
  249.       i) If all goes correctly, you should have a new RBBS-PC.EXE in your
  250.          current directory.  Copy this version on top of your old version,
  251.          (You backed it up first, right?) and copy ANSIED.HLP to your RBBS
  252.          help directory.
  253.  
  254.  
  255. You should be up and running with ANSIED!
  256.  
  257.  
  258. Guarantees:
  259.  
  260.    ANSIED is absolutely guaranteed to work exactly as you expect it to all
  261.    of the time.  It has no bugs and it's completely compatible with all
  262.    existing computers and their related software.  If ANSIED does not in
  263.    any way meet your expectations of it, simply return it with a
  264.    proof-of-purchase seal and we'll refund double your money.  Thank you
  265.    for purchasing ANSIED!
  266.  
  267.  
  268. Getting the latest version:
  269.  
  270.    ANSIED is not really a "product," so no effort is being undertaken to
  271.    distribute it wiidely.  In general, the latest version is available to
  272.    any FidoNet sysop who cares to request it.  To File request ANSIED, send
  273.    a file request to the MSFA BBS, Catonsville, MD, FidoNet node 1:261/1047,
  274.    and request the magic name "ANSIED" (without the quotes).  If you're not
  275.    a FidoNet sysop, and would like to obtain the latest version, try the
  276.    MSFA BBS (1-301-536-1935), under the P)ersonal downloads.
  277.  
  278.  
  279. Reaching the Author:
  280.  
  281.    To reach the author, enter a message in the FidoNet RBBS-PC echomail
  282.    conference, or leave a message on the MSFA BBS.
  283.  
  284.  
  285. New RBBS Versions:
  286.  
  287.    When a new RBBS version is released, there's an excellent chance that
  288.    ANSIED can be recompiled with the new RBBS version.  Start off by
  289.    merging the "EDIT" merges, and if they work, try some of the others.
  290.    Remember, though, any changes to the RBBS mainline code that results in
  291.    a new RBBS-VAR.BAS means that you have to recompile all modules,
  292.    including ANSIED.
  293.  
  294.  
  295. Questions and Answers:
  296.  
  297.    Q: What if I don't have QuickBASIC v4.5?
  298.  
  299.    A: ANSIED can be used with v3.0, but you'll have to use ANSIED-3.BAS.
  300.       The easiest way to use ANSIED-3.BAS is to use the UPGRADE3 batch
  301.       file, which works just like UPGRADE4.BAT.
  302.  
  303.       You can't use ANSIED with QuickBASIC v2.01 or BASCOM v1.00, because
  304.       it uses some of the v3.0+ statements.  ANSIED should be compilable
  305.       with some of the newer MicroSoft BASIC compilers, though I won't
  306.       swear to it.
  307.  
  308.    Q: I sometimes get 'String Space Corrupt' or other weird errors with
  309.       ANSIED.
  310.  
  311.    A: You forgot to make up a new RBBS-VAR.MOD and/or RBBS-VAR.BAS, didn't
  312.       you?
  313.  
  314.    Q: I sometimes get 'Out of String Space' errors with ANSIED.
  315.  
  316.    A: RBBS has gotten to be such a huge program that it's right on the
  317.       verge of being out of string space at all times, and ANSIED
  318.       aggrevates the problem.  ANSIED should work with RBBS v17.3, but
  319.       future versions may not work.  Try removing some of the excess RBBS
  320.       code with LITs.
  321.  
  322.  
  323.  
  324. -- Tom Collins, ANSIED author
  325.  
  326.